<!DOCTYPE html
  PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
  "DTD/xhtml1-strict.dtd">
<html>
  <head>
    <title>API docs for &ldquo;pymine.views&rdquo;</title>
    <meta content="text/html;charset=utf-8" http-equiv="Content-Type" />
    <link href="apidocs.css" type="text/css" rel="stylesheet" />
    
    
  </head>
  <body>
    <h1 class="module">Module p.views</h1>
    <p>
      <span id="part">Part of <a href="pymine.html">pymine</a></span>
      
      
    </p>
    <div>
      
    </div>
    <div>docstring goes here<table class="fieldTable"></table></div>
    
    
    <div id="splitTables">
      <table class="children sortable" id="id159">
  
  
  
  
  <tr class="function">
    
    
    <td>Function</td>
    <td><a href="pymine.views.html#__HTTP_BACKEND">__HTTP_BACKEND</a></td>
    <td><span>deal with a non-API HTTP request : GET and POST methods</span></td>
  </tr><tr class="function">
    
    
    <td>Function</td>
    <td><a href="pymine.views.html#HTTP_NOAUTH">HTTP_NOAUTH</a></td>
    <td><span>frontend to __HTTP_BACKEND and does not use the @login_required 
decorator</span></td>
  </tr><tr class="function">
    
    
    <td>Function</td>
    <td><a href="pymine.views.html#HTTP_AUTH">HTTP_AUTH</a></td>
    <td><span>frontend to __HTTP_BACKEND but uses the @login_required decorator</span></td>
  </tr><tr class="function">
    
    
    <td>Function</td>
    <td><a href="pymine.views.html#API_REST">API_REST</a></td>
    <td><span>deal with an API HTTP request : GET, POST and DELETE methods</span></td>
  </tr><tr class="function">
    
    
    <td>Function</td>
    <td><a href="pymine.views.html#get_favicon">get_favicon</a></td>
    <td><span>arguments: request, **kwargs</span></td>
  </tr><tr class="function">
    
    
    <td>Function</td>
    <td><a href="pymine.views.html#mine_public">mine_public</a></td>
    <td><span>arguments: request, suffix, **kwargs</span></td>
  </tr><tr class="function">
    
    
    <td>Function</td>
    <td><a href="pymine.views.html#mine_redirect">mine_redirect</a></td>
    <td><span>arguments: request, target, **kwargs</span></td>
  </tr><tr class="function">
    
    
    <td>Function</td>
    <td><a href="pymine.views.html#minekey_read">minekey_read</a></td>
    <td><span>arguments: request, mk_hmac, mk_fid, mk_fversion, mk_iid, mk_depth, 
mk_type, mk_ext, **kwargs</span></td>
  </tr><tr class="function">
    
    
    <td>Function</td>
    <td><a href="pymine.views.html#minekey_submit">minekey_submit</a></td>
    <td><span>arguments: request, mk_hmac, mk_fid, mk_fversion, mk_iid, mk_depth, 
mk_type, mk_ext, **kwargs</span></td>
  </tr><tr class="function">
    
    
    <td>Function</td>
    <td><a href="pymine.views.html#vurl_read_by_key">vurl_read_by_key</a></td>
    <td><span>arguments: request, vurlkey, **kwargs</span></td>
  </tr><tr class="function">
    
    
    <td>Function</td>
    <td><a href="pymine.views.html#vurl_read_by_name">vurl_read_by_name</a></td>
    <td><span>arguments: request, suffix, **kwargs</span></td>
  </tr>
  
</table>
      
      
    </div>
    
    
    
    <div class="function">
        <a name="pymine.views.__HTTP_BACKEND"></a>
        <a name="__HTTP_BACKEND"></a>
        <div class="functionHeader">
        
        def __HTTP_BACKEND(request, *args, **kwargs):
        
      </div>
        <div class="functionBody">
          
          <div>deal with a non-API HTTP request : GET and POST methods<table class="fieldTable"></table></div>
        </div>
      </div><div class="function">
        <a name="pymine.views.HTTP_NOAUTH"></a>
        <a name="HTTP_NOAUTH"></a>
        <div class="functionHeader">
        
        def HTTP_NOAUTH(request, *args, **kwargs):
        
      </div>
        <div class="functionBody">
          
          <div>frontend to __HTTP_BACKEND and does not use the @login_required 
decorator<table class="fieldTable"></table></div>
        </div>
      </div><div class="function">
        <a name="pymine.views.HTTP_AUTH"></a>
        <a name="HTTP_AUTH"></a>
        <div class="functionHeader">
        @login_required<br />
        def HTTP_AUTH(request, *args, **kwargs):
        
      </div>
        <div class="functionBody">
          
          <div>frontend to __HTTP_BACKEND but uses the @login_required decorator<table class="fieldTable"></table></div>
        </div>
      </div><div class="function">
        <a name="pymine.views.API_REST"></a>
        <a name="API_REST"></a>
        <div class="functionHeader">
        @login_required<br />
        def API_REST(request, *args, **kwargs):
        
      </div>
        <div class="functionBody">
          
          <div>deal with an API HTTP request : GET, POST and DELETE methods<table class="fieldTable"></table></div>
        </div>
      </div><div class="function">
        <a name="pymine.views.get_favicon"></a>
        <a name="get_favicon"></a>
        <div class="functionHeader">
        
        def get_favicon(request, **kwargs):
        
      </div>
        <div class="functionBody">
          
          <div>arguments: request, **kwargs implements: GET /favicon.ico returns: a 
punt to mine_public(request, 'images/favicon.ico', **kwargs)<table class="fieldTable"></table></div>
        </div>
      </div><div class="function">
        <a name="pymine.views.mine_public"></a>
        <a name="mine_public"></a>
        <div class="functionHeader">
        
        def mine_public(request, suffix, **kwargs):
        
      </div>
        <div class="functionBody">
          
          <div>arguments: request, suffix, **kwargs implements: GET /pub(/SUFFIX) 
returns: the output of httpserve.httpserve_path(request, suffix)<table class="fieldTable"></table></div>
        </div>
      </div><div class="function">
        <a name="pymine.views.mine_redirect"></a>
        <a name="mine_redirect"></a>
        <div class="functionHeader">
        
        def mine_redirect(request, target, **kwargs):
        
      </div>
        <div class="functionBody">
          
          <div>arguments: request, target, **kwargs implements: GET / returns: 
HttpResponseRedirect(target)<table class="fieldTable"></table></div>
        </div>
      </div><div class="function">
        <a name="pymine.views.minekey_read"></a>
        <a name="minekey_read"></a>
        <div class="functionHeader">
        
        def minekey_read(request, mk_hmac, mk_fid, mk_fversion, mk_iid, mk_depth, mk_type, mk_ext, **kwargs):
        
      </div>
        <div class="functionBody">
          
          <div>arguments: request, mk_hmac, mk_fid, mk_fversion, mk_iid, mk_depth, 
mk_type, mk_ext, **kwargs implements: GET 
/key/(MK_HMAC)/(MK_FID)/(MK_FVERSION)/(MK_IID)/(MK_DEPTH)/(MK_TYPE).(MK_EXT)
returns: a suitable HttpResponse object<table class="fieldTable"></table></div>
        </div>
      </div><div class="function">
        <a name="pymine.views.minekey_submit"></a>
        <a name="minekey_submit"></a>
        <div class="functionHeader">
        
        def minekey_submit(request, mk_hmac, mk_fid, mk_fversion, mk_iid, mk_depth, mk_type, mk_ext, **kwargs):
        
      </div>
        <div class="functionBody">
          
          <div>arguments: request, mk_hmac, mk_fid, mk_fversion, mk_iid, mk_depth, 
mk_type, mk_ext, **kwargs implements: POST 
/key/(MK_HMAC)/(MK_FID)/(MK_FVERSION)/(MK_IID)/(MK_DEPTH)/(MK_TYPE).(MK_EXT)
returns: a suitable HttpResponse object<table class="fieldTable"></table></div>
        </div>
      </div><div class="function">
        <a name="pymine.views.vurl_read_by_key"></a>
        <a name="vurl_read_by_key"></a>
        <div class="functionHeader">
        
        def vurl_read_by_key(request, vurlkey, **kwargs):
        
      </div>
        <div class="functionBody">
          
          <div>arguments: request, vurlkey, **kwargs implements: GET /vurl/(VURLKEY) 
returns: vurl.http_response()<table class="fieldTable"></table></div>
        </div>
      </div><div class="function">
        <a name="pymine.views.vurl_read_by_name"></a>
        <a name="vurl_read_by_name"></a>
        <div class="functionHeader">
        
        def vurl_read_by_name(request, suffix, **kwargs):
        
      </div>
        <div class="functionBody">
          
          <div>arguments: request, suffix, **kwargs implements: GET /page/(SUFFIX) 
returns: vurl.http_response()<table class="fieldTable"></table></div>
        </div>
      </div>
    
    <address>
      <a href="index.html">API Documentation</a> for pymine, generated by <a href="http://codespeak.net/~mwh/pydoctor/">pydoctor</a> at 2010-04-07 23:15:24.
    </address>
  </body>
</html>